Windows Installation Guide for Stirling PDF
Stirling PDF provides Windows compatibility through a downloadable .exe files depending on your usecase! For personal user we recommend the latest Stirling-PDF-installer
For Server use (wanting to host Stirling-PDF as a server to share with multiple users) We recommend downloading the Stirling-PDF-server.exe This version also requires you to install the latest java jdk21 you can get the installer here
Optional Dependencies
These dependencies enable additional features in Stirling PDF. Install only the ones you need:
Python and Related Tools
Python and its related tools enable various features in Stirling PDF:
- OpenCV: Enables image scan extraction features
- Unoconv: Enables file to PDF conversion features
- Python: Required base for OpenCV and other Python-based features
-
Python Installation:
- Download Python from Python's official site
- During installation, IMPORTANT: Check "Add Python to PATH"
- Verify installation by opening Command Prompt and running:
python --version
-
OpenCV Installation:
- After Python is installed, open Command Prompt as administrator
- Install OpenCV by running:
pip install opencv-python
- Verify installation:
python -c "import cv2"
- Enables Extract Image Scans operation
-
Unoconv Installation:
- First install LibreOffice (see LibreOffice section below)
- Open Command Prompt as administrator
- Install unoconv:
pip install unoconv
- Verify installation:
unoconv --version
- Enables File To PDF operation Note: Unoconv requires both Python and LibreOffice to function properly
QPDF
- Download from QPDF's official site
- Enables PDF compression and other operations
LibreOffice
- Download and install from LibreOffice's official site
- Enables PDF to DOCX conversion and other document format conversions
Tesseract OCR
- Download the installer from UB Mannheim's GitHub
- During installation, check additional languages you need
- Add to settings.yml in your Stirling PDF installation directory:
system:
tessdataDir: C:\\Program Files\\Tesseract-OCR\\tessdata
- Enables OCR functionality for PDFs
Weasyprint
- Download from Weasyprint's releases
- Create a directory (e.g.,
c:\weasyprint\
) and place weasyprint.exe there
- Enables URL to PDF conversion
- Note: Some antivirus software may flag weasyprint.exe - you may need to whitelist it
PDFtoHTML
- Download from SourceForge
- Create a directory (e.g.,
c:\pdftohtml\
) and place pdftohtml.exe there
- Enables PDF to HTML conversion
Adding Directories to System PATH
After installing dependencies, you'll need to add their directories to your system's PATH. Here's how:
- Open Windows Search (Windows key + S)
- Type "Environment Variables" and click "Edit the system environment variables"
- Click "Environment Variables" button at the bottom
- Under "System variables", find and select "Path"
- Click "Edit"
- Click "New" to add each required path:
- For Python: Should be added automatically during installation if "Add Python to PATH" was checked
- For LibreOffice:
C:\Program Files\LibreOffice\program
- For Tesseract:
C:\Program Files\Tesseract-OCR
- For Weasyprint:
C:\weasyprint
(or your chosen directory) - For PDFtoHTML:
C:\pdftohtml
(or your chosen directory) - For QPDF: The installation directory (usually
C:\Program Files\qpdf\bin
)
- Click "OK" on all windows to save changes
Server Installation Steps
- Download the latest Stirling PDF-server.exe or jar from the releases page
- Install any desired optional dependencies following the instructions above
- Launch the Stirling PDF executable
- Access the web interface through your browser (the application will provide the URL) in the console logs normally http://localhost:8080
Notes
- The application hosts a web server that is accessible to anyone on your network
- If you install multiple Python-based dependencies, ensure they're using the same Python installation to avoid conflicts
- Make sure to restart Stirling PDF after installing new dependencies or modifying PATH variables
- Some features will be unavailable until their required dependencies are installed
Troubleshooting
-
Verifying PATH Settings:
- Open Command Prompt (cmd)
- Type
echo %PATH%
to see all directories in your PATH - For each dependency, try running its command to verify it's accessible:
python --version
unoconv --version
python -c "import cv2"
tesseract --version
-
Common Issues:
- If changes to PATH don't take effect, try:
- Logging out and back in
- Restarting your computer
- Opening a new Command Prompt window
- If a dependency isn't found, double-check the exact path in File Explorer
- For Tesseract issues, verify the tessdata directory contains language files
- For LibreOffice conversions, ensure no LibreOffice windows are open when converting
- For Python/OpenCV issues:
- Make sure pip is up to date:
python -m pip install --upgrade pip
- Try installing with administrator privileges
- Check if Python is properly added to PATH
- Make sure pip is up to date:
- For unoconv issues:
- Verify both Python and LibreOffice are properly installed
- Make sure LibreOffice is in PATH
- Try running LibreOffice once before using unoconv
- If changes to PATH don't take effect, try:
Need help? Visit the Stirling PDF GitHub Issues page.